Eclipse Platform
Pre-release 3.0

org.eclipse.core.filebuffers
Interface ITextFileBuffer

All Superinterfaces:
IFileBuffer

public interface ITextFileBuffer
extends IFileBuffer

A text file buffer is a file buffer for text files. The contents of a text file buffe is given in the form of a document. Also, the text file buffer provides methods to manage the character encoding used to read and write the buffer's underlying text file.

Since:
3.0

Method Summary
 IDocument getDocument()
          Returns the document of this text file buffer.
 String getEncoding()
          Returns the character encoding to be used for reading and writing the buffer's underlying file.
 void setEncoding(String encoding)
          Sets the character encoding to be used for reading and writing the buffer's underlyning file.
 
Methods inherited from interface org.eclipse.core.filebuffers.IFileBuffer
commit, getLocation, getModifcationStamp, getStatus, isDirty, isShared, isStateValidated, isSynchronized, resetStateValidation, revert, validateState
 

Method Detail

getDocument

public IDocument getDocument()
Returns the document of this text file buffer.

Returns:
the document of this text file buffer

getEncoding

public String getEncoding()
Returns the character encoding to be used for reading and writing the buffer's underlying file.

Returns:
the character encoding

setEncoding

public void setEncoding(String encoding)
Sets the character encoding to be used for reading and writing the buffer's underlyning file.

Parameters:
encoding - the encoding

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.